也就是|左上角_AbstractProcessor相关的API记录

java文件操作相关的两个类&＃xff1a; JCTree 树节点、TreeMaker 树节点构建器。

JCTree

JCTree的一个子类就是java语法中的一个节点&＃xff0c;类、方法、字段等这些都被封装成了一个JCTree子类。

JCTree详细的介绍&＃xff1a;抽象语法树AST的全面解析&＃xff08;二&＃xff09; - 简书

TreeMaker

TreeMaker 里的方法用于构建JCTree某个子类&＃xff0c;例&＃xff1a;treeMaker.MethodDef(…)返回值是JCTree的子类JCMethodDecl&＃xff08;方法节点&＃xff09;

TreeMaker创建各种节点的方法如下&＃xff1a;

// public访问修饰符
JCTree.JCModifiers publicDot &＃61; treeMaker.Modifiers(Flags.PUBLIC);
// void关键字
JCTree.JCPrimitiveTypeTree voidDot &＃61; treeMaker.TypeIdent(TypeTag.VOID);
// 空语句
JCTree.JCBlock emptyDot &＃61; treeMaker.Block(0, List.nil());
// 一个无参构造方法
JCTree.JCMethodDecl noArgsMethod &＃61; treeMaker.MethodDef(
publicDot,
names.fromString(""),
voidDot ,
List.nil(),
List.nil(),
List.nil(),
emptyDot,
null);
// this关键字
JCTree.JCIdent thisDot &＃61; treeMaker.Ident(names.fromString("this"));
// userPassword (Name类型可以是方法名、字段名、变量名、类名)
Name userPasswordName &＃61; names.fromString("userPassword");
// this.userPassword (访问当前方法中的字段userPassword)
JCTree.JCFieldAccess thisUserPassword &＃61; treeMaker.Select(thisDot , userPasswordName);
// userPassword 变量
JCTree.JCIdent userPassword &＃61; treeMaker.Ident(userPasswordName);
// this.userPassword &＃61; userPassword (treeMaker.Apply()以及treeMaker.Assign()需要外面包一层treeMaker.Exec())
treeMaker.Exec(treeMaker.Assign(thisUserPassword, userPassword));


 如以下代码是给一个方法新增一句话System.out.println("hello world")

package jst;
import com.google.auto.service.AutoService;
import com.sun.tools.javac.model.JavacElements;
import com.sun.tools.javac.processing.JavacProcessingEnvironment;
import com.sun.tools.javac.tree.JCTree;
import com.sun.tools.javac.tree.TreeMaker;
import com.sun.tools.javac.util.Context;
import com.sun.tools.javac.util.List;
import javax.annotation.processing.*;
import javax.lang.model.SourceVersion;
import javax.lang.model.element.Element;
import javax.lang.model.element.TypeElement;
import java.util.Set;
/**
* &＃64;author wuweifeng wrote on 2022/12/21
* &＃64;version 1.0
*/
&＃64;SupportedAnnotationTypes("jst.HelloWorld")
&＃64;SupportedSourceVersion(SourceVersion.RELEASE_8)
&＃64;AutoService(Processor.class)
public class MyProcessor extends AbstractProcessor
&＃64;Override
public boolean process(Set annotations, RoundEnvironment roundEnv)
Set elements &＃61; roundEnv.getRootElements();
final Context context &＃61; ((JavacProcessingEnvironment) processingEnv).getContext();
final JavacElements elementUtils &＃61; (JavacElements) processingEnv.getElementUtils();
final TreeMaker treeMaker &＃61; TreeMaker.instance(context);
for (Element element : roundEnv.getElementsAnnotatedWith(HelloWorld.class))
JCTree.JCMethodDecl jcMethodDecl &＃61; (JCTree.JCMethodDecl) elementUtils.getTree(element);
treeMaker.pos &＃61; jcMethodDecl.pos;
jcMethodDecl.body &＃61; treeMaker.Block(0, List.of(
treeMaker.Exec(
treeMaker.Apply(
List.nil(),
treeMaker.Select(
treeMaker.Select(
treeMaker.Ident(
elementUtils.getName("System")
),
elementUtils.getName("out")
),
elementUtils.getName("println")
),
List.of(
treeMaker.Literal("Hello, world!!!")
)
)
),
jcMethodDecl.body
));

return false;



使用时

&＃64;HelloWorld
public static void main(String[] args)
System.out.println("demo打印");


加上了&＃64;HelloWorld注解后&＃xff0c;运行就会打印

现在针对MyProcessor类里的内容做个解释。

jcMethodDecl.body即为方法体&＃xff0c;利用treemaker的Block方法获取到一个新方法体&＃xff0c;将原来的替换掉。就达到了修改方法体的目的了。这里的Block方法有两个参数&＃xff0c;重点要关注的是第二个参数&＃xff0c;也就是具体的方法体内容。它是一个List类型的参数&＃xff0c;List里面每一个元素就代表一个语句块&＃xff0c;比如&＃xff0c;例子中有两块语句&＃xff0c;第一块是我们织入的代码块&＃xff1a;System.out.println("Hello, world!!!")&＃xff1b;用treeMaker.Exec()来实现&＃xff0c;第二块是原来的代码块&＃xff1a;jcMethodDecl.body。这块的代码是用户原本的代码&＃xff0c;我们直接放进来就行。这个List是有顺序的&＃xff0c;谁的顺序在前&＃xff0c;谁最终生成的代码块就在前&＃xff0c;比如这里我们织入的代码在原来的代码块之前&＃xff0c;所以最终生成System.out.println("Hello, world!!!");语句就在该方法的第一行位置。

重点关注的应该是treeMaker.Exec()这个方法&＃xff0c;这个方法帮助我们最终生成了System.out.println("Hello, world!!!")&＃xff1b;这条语句&＃xff0c;它的参数是treeMaker.Apply这个方法的返回结果&＃xff0c;这个方法的第二个参数&＃xff0c;也就是最终实现了输出System.out.println("Hello, world!!!")的东西。

这里面用到了两个方法&＃xff0c;一个是treeMaker.Select&＃xff08;生成具体的方法&＃xff09;&＃xff0c;一个是treeMaker.Literal&＃xff08;方法的参数&＃xff09;。treeMaker.Select里面套了很多层&＃xff0c;对比两种写法的区别&＃xff0c;你也能明白&＃xff0c;这是为了写出多级方法的做法&＃xff0c;多级方法的第一级以treeMaker.Ident开始&＃xff0c;然后一层套一层&＃xff0c;直到整个方法结束。

如何debug processor代码

a)idea右上角&＃xff0c;Edit Configurations

b)点击左上角的&＃43;号&＃xff0c;选择Remote&＃xff0c;或者如图的Remote JVM debug

c)随便起一个名字&＃xff0c;比如ProcessorDebug&＃xff0c;如图&＃xff0c;点击确定。

d)进入Terminal界面&＃xff0c;输入mvnDebug clean install&＃xff0c;回车&＃xff0c;不出意外的话&＃xff0c;会出现如图的提示

f)process里面打上断点&＃xff0c;然后点击debug按钮&＃xff0c;便命中了断点

异常情况 

如果在rebuild project时出现&＃xff1a;java: java.lang.ClassCastException: com.sun.proxy.$Proxy26 cannot be cast to com.sun.tools.javac.processing.JavacProcessingEnvironment

则在设置里添加如下内容&＃xff1a;

-Djps.track.ap.dependencies&＃61;false